home *** CD-ROM | disk | FTP | other *** search
/ Aminet 30 / Aminet 30 (1999)(Schatztruhe)[!][Apr 1999].iso / Aminet / dev / mui / MCC_TWFmLED.lha / MCC_TWFmultiLED / Developer / Autodocs / MCC_TWFmultiLED.doc next >
Text File  |  1999-02-25  |  6KB  |  183 lines
  1. TABLE OF CONTENTS
  2.  
  3. TWFmultiLED.mcc/TWFmultiLED.mcc
  4. TWFmultiLED.mcc/MUIA_TWFmultiLED_Colour
  5. TWFmultiLED.mcc/MUIA_TWFmultiLED_Custom
  6. TWFmultiLED.mcc/MUIA_TWFmultiLED_Free
  7. TWFmultiLED.mcc/MUIA_TWFmultiLED_TimeDelay
  8. TWFmultiLED.mcc/MUIA_TWFmultiLED_Type
  9.  
  10. TWFmultiLED.mcc/TWFmultiLED.mcc                  TWFmultiLED.mcc/TWFmultiLED.mcc
  11.  
  12.     This class is a fairly simple implementation of a "LED-like" indicator which
  13. provides the programmer with a new method for communicating program state to
  14. the user. Unlike other similar implementations, TWFmultiLED allows both the
  15. user and programmer to specify both the shape of the indicator and it's colour.
  16.  
  17.     Via the preferences program the user can specify the RGB makeup of the 6
  18. internal colours (used to represent the states "Off", "On", "Ok", "Loading",
  19. "Error" and "Panic") and the default shape of the indicator. The programmer
  20. can abide by the user's choice of shape, or override it and use one fo the
  21. other shapes. The programmer can also set the indicator to any of the 6 user
  22. defined colours or to a custom colour the programmer specifies.
  23.  
  24. TWFmultiLED.mcc/MUIA_TWFmultiLED_Colour
  25.  
  26.   NAME
  27.     MUIA_TWFmultiLED_Colour -- [IS.], ULONG
  28.  
  29.   INPUTS
  30.     MUIV_TWFmultiLED_Colour_Off       Set LED to user defined Off colour.
  31.     MUIV_TWFmultiLED_Colour_On        Set LED to user defined On colour.
  32.     MUIV_TWFmultiLED_Colour_Ok        Set LED to user defined Ok colour.
  33.     MUIV_TWFmultiLED_Colour_Working   Set LED to user defined Working colour.
  34.     MUIV_TWFmultiLED_Colour_Waiting   Set LED to user defined Waiting colour.
  35.     MUIV_TWFmultiLED_Colour_Load      Set LED to user defined Load colour.
  36.     MUIV_TWFmultiLED_Colour_Cancelled Set LED to user defined Cancelled colour.
  37.     MUIV_TWFmultiLED_Colour_Stopped   Set LED to user defined Stopped colour.
  38.     MUIV_TWFmultiLED_Colour_Error     Set LED to user defined Error colour.
  39.     MUIV_TWFmultiLED_Colour_Panic     Set LED to user defined Panic colour.
  40.     MUIV_TWFmultiLED_Colour_Custom    Set LED to programmer specified colour
  41.  
  42.     MUIV_TWFmultiLED_Colour_Off is the default value.
  43.  
  44.   FUNCTION
  45.     This attribute allows you to change the colour shown in the indicator. The
  46.     indicator will only change colour if the value you specify is valid and
  47.     the pen for that colour has been obtained successfully.
  48.  
  49.  
  50.   NOTE
  51.     Specifying MUIV_TWFmultiLED_Colour_Custom will have no effect unless you
  52.     have set a value for MUIA_TWFmultiLED_Custom AND the window is open.
  53.     Specifying MUIV_TWFmultiLED_Colour_Custom during initialisation will have
  54.     no effect.
  55.  
  56.  
  57.   BUGS
  58.     No known bugs.
  59.  
  60.  
  61.   SEE ALSO
  62.     MUIA_TWFmultiLED_Custom
  63.  
  64.  
  65. TWFmultiLED.mcc/MUIA_TWFmultiLED_Custom
  66.  
  67.   NAME
  68.     MUIA_TWFmultiLED_Custom -- [IS.], struct TWFmultiLED_RGB *
  69.  
  70.  
  71.   FUNCTION
  72.     Using this attribute, the programmer can specify an RGB value to display in
  73.     the indicator. The RGB values should be 32 bit left justified fractions
  74.     as used by graphics.library/SetRGB32()
  75.  
  76.  
  77.   EXAMPLE
  78.  
  79.     struct TWFmultiLED_RGB egColour = { 0xFFFFFFFF, 0, 0xFFFFFFFF };
  80.  
  81.     ...
  82.  
  83.     Child, ML_Indicator = TWFmultiLEDObject,
  84.         ...
  85.     End,
  86.  
  87.     ...
  88.  
  89.     set(ML_Indicator, MUIA_TWFmultiLED_Custom, &egColour);
  90.     set(ML_Indicator, MUIA_TWFmultiLED_Colour, MUIV_TWFmultiLED_Colour_Custom);
  91.  
  92.  
  93.   BUGS
  94.     No known bugs.
  95.  
  96.  
  97.   SEE ALSO
  98.     MUIA_TWFmultiLED_Colour, graphics.library/SetRGB32
  99.  
  100.  
  101. TWFmultiLED.mcc/MUIA_TWFmultiLED_Free
  102.  
  103.   NAME
  104.     MUIA_TWFmultiLED_Free -- [IS.], BOOL
  105.  
  106.  
  107.   FUNCTION
  108.     This attribute only affects the square and rectangular indicators. If set
  109.     to TRUE then both the maximum height and width are set to 40. The indicator
  110.     will resize as the user changes the window size.
  111.  
  112.  
  113.   BUGS
  114.     No known bugs.
  115.  
  116. TWFmultiLED.mcc/MUIA_TWFmultiLED_TimeDelay
  117.  
  118.   NAME
  119.     MUIA_TWFmultiLED_TimeDelay -- [IS.], ULONG
  120.  
  121.  
  122.   INPUTS
  123.     Delay, in seconds, between the LED colour being set and it being automatically
  124.     reset to MUIV_TWFmultiLED_Colour_Off. To deactivate this feature you can
  125.     supply the special value.
  126.  
  127.  
  128.   SPECIAL VALUES
  129.     MUIV_TWFmultiLED_TimeDelay_User     Use the user's setting
  130.  
  131.     MUIV_TWFmultiLED_TimeDelay_Off      Disable the deactivation feature.
  132.                                         (This is the default)
  133.  
  134.   FUNCTION
  135.     This attribute allows an indicator lamp to "turn itself off" automatically
  136.     after a delay period. This could be useful in many situations, especially
  137.     if the indicator is being used to display repeating events.
  138.  
  139.  
  140.   BUGS
  141.     None reported. This is the least tested of the features so there may be
  142.     some bugs I have not found. Please inform me immediately if anything
  143.     unexpected occurs while using this attribute.
  144.  
  145.   SEE ALSO
  146.  
  147. TWFmultiLED.mcc/MUIA_TWFmultiLED_Type
  148.  
  149.   NAME
  150.     MUIA_TWFmultiLED_Type -- [IS.], ULONG
  151.  
  152.  
  153.   INPUTS
  154.     MUIV_TWFmultiLED_Type_Round5    Indicator is drawn as a small circle.
  155.     MUIV_TWFmultiLED_Type_Round11   Indicator is drawn as a large circle.
  156.     MUIV_TWFmultiLED_Type_Square5   Indicator is drawn as a small square.
  157.     MUIV_TWFmultiLED_Type_Square11  Indicator is drawn as a large square.
  158.     MUIV_TWFmultiLED_Type_Rect11    Indicator is drawn as a small rectangle.
  159.     MUIV_TWFmultiLED_Type_Rect15    Indicator is drawn as a large rectangle.
  160.     MUIV_TWFmultiLED_Type_User      The indicator shape is set by the user,
  161.                                     this is the default.
  162.  
  163.  
  164.   FUNCTION
  165.     This attribute allows the programmer to alter the shape of the indicator.
  166.     This should not be used unless absolutely necessary - the user's
  167.     preference is the default and you should not override it unless you
  168.     have a very good reason.
  169.  
  170.  
  171.   NOTE
  172.     When you set this attribute, the indicator will be temporarily hidden
  173.     and then redisplayed. This forces MUI to ask for the indicator's
  174.     dimensions but it may affect your layout.
  175.  
  176.  
  177.   BUGS
  178.     No known bugs.
  179.  
  180.   SEE ALSO
  181.  
  182.  
  183.